update DFA path runscript [ana5; runscripts] #1039

leon-wagner · 2024-10-22T11:03:43Z

With the goal of addressing #848, as well as rework of the runScript

Summary of changes:

restructured runComputeDFAPath script to make it compatible with QGIS connector, moved script to /avaframe
the --runDFA flag can now be set to run com1 to generate results for path generation (this was previously handled by a True/False argument within the runScript). The avaFolder may now also be added to the run command.
settings that are used to override com1DFA run were moved to DFAPath cfg as overrides. changed some of the overrides, path is now essentially generated from a default null com1 run with standard friction and particle settings. path is now also generated from fields as default, instead of from particles.
if splitpoint is not found with the set angle (default 20 degrees), the splitpoint is now generated at the top of the path, instead of not creating one. changed plot output accordingly.
added missing discrete color levels for travel angle, so now colors in the path output plot are generated with the same levels.
color map for travel angles is now Crameri:nuuk (previously was undefined and a mix of Crameri:batlow and Crameri:lapaz)
fixes above remove 2 user warnings in DFAPath script log, one with legend, one with cmap
fix DFA path generation returns no coordinates for splitpoint #1038

To do:

update documentation with changes

pep8speaks · 2024-11-11T10:21:04Z

Hello @leon-wagner! Thanks for updating this PR.

In the file avaframe/ana1Tests/energyLineTest.py:

Line 215:121: E501 line too long (152 > 120 characters)
Line 205:22: W605 invalid escape sequence '\D'

In the file avaframe/ana5Utils/DFAPathGeneration.py:

Line 714:1: E302 expected 2 blank lines, found 1
Line 712:18: E231 missing whitespace after ','
Line 706:121: E501 line too long (127 > 120 characters)
Line 109:1: E302 expected 2 blank lines, found 1
Line 105:16: E231 missing whitespace after ','
Line 89:121: E501 line too long (128 > 120 characters)
Line 68:10: E261 at least two spaces before inline comment
Line 59:74: E127 continuation line over-indented for visual indent
Line 52:13: E117 over-indented
Line 51:13: E117 over-indented (comment)
Line 50:21: E261 at least two spaces before inline comment
Line 32:1: E302 expected 2 blank lines, found 1

In the file avaframe/in2Trans/shpConversion.py:

Line 420:52: E203 whitespace before ':'
Line 418:48: E203 whitespace before ':'
Line 417:48: E203 whitespace before ':'

In the file avaframe/out3Plot/outCom3Plots.py:

Line 193:54: E262 inline comment should start with '# '
Line 193:53: E261 at least two spaces before inline comment
Line 175:121: E501 line too long (139 > 120 characters)
Line 170:54: E262 inline comment should start with '# '
Line 170:53: E261 at least two spaces before inline comment
Line 167:121: E501 line too long (122 > 120 characters)
Line 148:54: E262 inline comment should start with '# '
Line 148:53: E261 at least two spaces before inline comment
Line 73:121: E501 line too long (131 > 120 characters)
Line 71:74: E251 unexpected spaces around keyword / parameter equals
Line 71:72: E251 unexpected spaces around keyword / parameter equals
Line 69:93: E251 unexpected spaces around keyword / parameter equals
Line 69:91: E251 unexpected spaces around keyword / parameter equals
Line 69:59: W605 invalid escape sequence '\m'
Line 30:121: E501 line too long (125 > 120 characters)

In the file avaframe/out3Plot/plotUtils.py:

Line 979:121: E501 line too long (138 > 120 characters)
Line 977:19: E712 comparison to False should be 'if cond is False:' or 'if not cond:'
Line 948:21: E712 comparison to False should be 'if cond is False:' or 'if not cond:'
Line 805:121: E501 line too long (124 > 120 characters)
Line 689:37: E203 whitespace before ':'
Line 688:37: E203 whitespace before ':'
Line 537:15: E711 comparison to None should be 'if cond is not None:'
Line 501:71: E203 whitespace before ':'
Line 501:48: E203 whitespace before ':'
Line 495:71: E203 whitespace before ':'
Line 495:48: E203 whitespace before ':'
Line 482:121: E501 line too long (121 > 120 characters)

In the file avaframe/runAna5DFAPathGeneration.py:

Line 85:1: E305 expected 2 blank lines after class or function definition, found 1
Line 83:19: E231 missing whitespace after ','
Line 21:1: E302 expected 2 blank lines, found 1

In the file avaframe/tests/test_DFAPathGeneration.py:

Line 112:5: E303 too many blank lines (2)
Line 72:20: E262 inline comment should start with '# '
Line 72:20: E261 at least two spaces before inline comment

Comment last updated at 2024-12-02 12:22:49 UTC

…t or other)

…on.py - com1 overrides moved from runScript to ini - new --runDFA flag logic - path is generated from fields by default (resType changed accordingly) - moved runScript to main avaframe folder (for QGIS) - clean DFAPath output folder in avadir before generating path (necessary for QGIS, so if script is run multiple times, paths that are previously generated are not returned to QGIS)

- removed coulomb friction and other com1 overrides, path is now generated from standard run - added option to add velocity info when FV is saved

… instead of not at all (avoids issues with QGIS) - adjusted corresponding error message - accordingly adjusted plot generation to exclude splitPoints set at the top

- add missing discrete color levels for Travel Angle and changed it from a mix of lapaz and batlow to nuuk color map - grey out faulty legend plotting line thereby removing user warning: “no artists found with label”… in log and removes empty legend in top right corner of birds eye view panel - more descriptive runDFA flag comment in runScript

- set dt to 1

…t or other) - adjustment to writePoint2SHPfile to account for pytest. tested and it still fixes the addressed problem.